home *** CD-ROM | disk | FTP | other *** search
/ ADA Programming Guide / ADA Programming Guide.iso / adatutor / lrmrdr / sddtoc.doc < prev    next >
Text File  |  1996-01-30  |  9KB  |  498 lines
  1. <!OPS, Version = 6.4>
  2.  
  3. <!Document,
  4.     Final Output Device =    "cx",
  5.     Default Printer =    "cx1">
  6.  
  7. <!Font Definitions,
  8.     F40 = Thames 10,
  9.     F49 = Thames 12 Bold,
  10.     F84 = Swiss 10,
  11.     F93 = Swiss 12 Bold,
  12.     F97 = Swiss 14 Bold>
  13.  
  14. <!Page,
  15.     Left Margin =        1.50 inches,
  16.     Right Margin =        1.50 inches,
  17.     Starting Page # =     Inherit,
  18.     Page # Style =        Lower Case Roman,
  19.     Hyphenation =        on>
  20.  
  21. <!Autonumber Stream, list, 1>
  22.  
  23. <!Class, sectionTOC,
  24.     Top Margin =        0.20 inches,
  25.     Bottom Margin =        0 inches,
  26.     Left Margin =        0.25 inches,
  27.     First Indent =        -0.50 inches,
  28.     Line Spacing =        1 lines,
  29.     Alignment =        Left,
  30.     Font =            F93,
  31.     Allow Page Break Within = no,
  32.     Allow Page Break After = no,
  33.     Left Tab =        -0.25 Inches,
  34.     Right Tab =        4.50/5 Inches>
  35.  
  36. <!Class, subsectionTOC,
  37.     Top Margin =        0.04 inches,
  38.     Bottom Margin =        0 inches,
  39.     Left Margin =        0.25 inches,
  40.     First Indent =        -0.25 inches,
  41.     Line Spacing =        1 lines,
  42.     Alignment =        Left,
  43.     Font =            F84,
  44.     Allow Page Break Within = no,
  45.     Left Tab =        -0.25 Inches,
  46.     Right Tab =        4.50/5 Inches>
  47.  
  48. <!Class, subsubsectionTOC,
  49.     Top Margin =        0.04 inches,
  50.     Bottom Margin =        0 inches,
  51.     Left Margin =        0.25 inches,
  52.     First Indent =        -0.25 inches,
  53.     Line Spacing =        1 lines,
  54.     Alignment =        Left,
  55.     Font =            F84,
  56.     Allow Page Break Within = no,
  57.     Left Tab =        -0.25 Inches,
  58.     Right Tab =        4.50/5 Inches>
  59.  
  60. <!Class, subsubsubsectionTOC,
  61.     Top Margin =        0.04 inches,
  62.     Bottom Margin =        0 inches,
  63.     Left Margin =        0.25 inches,
  64.     First Indent =        -0.25 inches,
  65.     Line Spacing =        1 lines,
  66.     Alignment =        Left,
  67.     Font =            F84,
  68.     Allow Page Break Within = no,
  69.     Left Tab =        -0.25 Inches,
  70.     Right Tab =        4.50/5 Inches>
  71.  
  72. <!Class, title,
  73.     Top Margin =        0.20 inches,
  74.     Bottom Margin =        0 inches,
  75.     Left Margin =        0.25 inches,
  76.     First Indent =        -0.50 inches,
  77.     Line Spacing =        1 lines,
  78.     Alignment =        Center,
  79.     Font =            F97,
  80.     Allow Page Break Within = no,
  81.     Allow Page Break After = no,
  82.     Left Tab =        -0.25 Inches,
  83.     Right Tab =        4.50/5 Inches>
  84.  
  85. <!Master Frame,
  86.     Name =            floating,
  87.     Placement =        Following Anchor,
  88.     Horizontal Alignment =    Center,
  89.     Width =            Page Without Margins,
  90.     Height =        Page Without Margins * 0.33,
  91.     Diagram =
  92. V6,
  93. (g9,0,0)>
  94.  
  95. <title>
  96.  
  97. <|,ii>SOFTWARE DESIGN DOCUMENT
  98.  
  99. <title>
  100.  
  101. for the
  102.  
  103. <title>
  104.  
  105. Ada LRM READER
  106.  
  107. <title,
  108.     Bottom Margin =        1 inches>
  109.  
  110. TABLE OF CONTENTS
  111.  
  112. <sectionTOC>
  113.  
  114. 1. Scope<Tab.><Tab>1
  115.  
  116. <sectionTOC>
  117.  
  118. 2. References<Tab.><Tab>2
  119.  
  120. <subsectionTOC>
  121.  
  122. 2.1. Documents<Tab.><Tab>2
  123.  
  124. <subsectionTOC>
  125.  
  126. 2.2. Terminology<Tab.><Tab>2
  127.  
  128. <sectionTOC>
  129.  
  130. 3. Design<Tab.><Tab>3
  131.  
  132. <subsectionTOC>
  133.  
  134. 3.1. CSCI overview<Tab.><Tab>3
  135.  
  136. <subsubsectionTOC>
  137.  
  138. 3.1.1. CSCI architecture<Tab.><Tab>4
  139.  
  140. <subsubsubsectionTOC>
  141.  
  142. 3.1.1.1. Object Interaction Diagram for the LRM_Reader Task<Tab.><Tab>5
  143.  
  144. <subsubsubsectionTOC>
  145.  
  146. 3.1.1.2. Dependency Diagram for the LRM_Reader Task<Tab.><Tab>6
  147.  
  148. <subsubsubsectionTOC>
  149.  
  150. 3.1.1.3. Dependency Diagram for the Make_DAF Task<Tab.><Tab>7
  151.  
  152. <subsubsubsectionTOC>
  153.  
  154. 3.1.1.4. Dependency Diagram for the Make_Cit Task<Tab.><Tab>8
  155.  
  156. <subsubsectionTOC>
  157.  
  158. 3.1.2. System States for LRM_Reader Task<Tab.><Tab>9
  159.  
  160. <subsubsubsectionTOC>
  161.  
  162. 3.1.2.1. State Table<Tab.><Tab>9
  163.  
  164. <subsubsubsectionTOC>
  165.  
  166. 3.1.2.2. State Transition Diagram<Tab.><Tab>9
  167.  
  168. <subsubsubsectionTOC>
  169.  
  170. 3.1.2.3. State/Associated CSC Table<Tab.><Tab>10
  171.  
  172. <subsubsectionTOC>
  173.  
  174. 3.1.3. Memory and processing time allocation<Tab.><Tab>11
  175.  
  176. <subsubsubsectionTOC>
  177.  
  178. 3.1.3.1. LRM_Reader-based Task<Tab.><Tab>11
  179.  
  180. <subsubsubsectionTOC>
  181.  
  182. 3.1.3.2. Make_Cit-based Task<Tab.><Tab>11
  183.  
  184. <subsubsubsectionTOC>
  185.  
  186. 3.1.3.3. Make_DAF-based Task<Tab.><Tab>11
  187.  
  188. <subsectionTOC>
  189.  
  190. 3.2. CSCI design description<Tab.><Tab>12
  191.  
  192. <subsubsectionTOC>
  193.  
  194. 3.2.1. LRM_Reader Procedure<Tab.><Tab>12
  195.  
  196. <subsubsectionTOC>
  197.  
  198. 3.2.2. Make_DAF Procedure<Tab.><Tab>13
  199.  
  200. <subsubsectionTOC>
  201.  
  202. 3.2.3. Make_Cit  Procedure<Tab.><Tab>15
  203.  
  204. <subsubsectionTOC>
  205.  
  206. 3.2.4. SYSDEP Package<Tab.><Tab>18
  207.  
  208. <subsubsectionTOC>
  209.  
  210. 3.2.5. Citation_Definition  Package<Tab.><Tab>20
  211.  
  212. <subsubsectionTOC>
  213.  
  214. 3.2.6. DAF_Handler Package<Tab.><Tab>21
  215.  
  216. <subsubsubsectionTOC>
  217.  
  218. 3.2.6.1. Create Procedure<Tab.><Tab>25
  219.  
  220. <subsubsubsectionTOC>
  221.  
  222. 3.2.6.2. Write Procedure<Tab.><Tab>25
  223.  
  224. <subsubsubsectionTOC>
  225.  
  226. 3.2.6.3. Close_Create Procedure<Tab.><Tab>26
  227.  
  228. <subsubsubsectionTOC>
  229.  
  230. 3.2.6.4. Open Function<Tab.><Tab>27
  231.  
  232. <subsubsubsectionTOC>
  233.  
  234. 3.2.6.5. Is_Open Function<Tab.><Tab>28
  235.  
  236. <subsubsubsectionTOC>
  237.  
  238. 3.2.6.6. Is_End_of_File Function<Tab.><Tab>28
  239.  
  240. <subsubsubsectionTOC>
  241.  
  242. 3.2.6.7. Read Function<Tab.><Tab>29
  243.  
  244. <subsubsubsectionTOC>
  245.  
  246. 3.2.6.8. Read_Next Function<Tab.><Tab>29
  247.  
  248. <subsubsubsectionTOC>
  249.  
  250. <|,iii>3.2.6.9. Close Procedure<Tab.><Tab>30
  251.  
  252. <subsubsectionTOC>
  253.  
  254. 3.2.7. Command_Dispatcher Package<Tab.><Tab>30
  255.  
  256. <subsubsubsectionTOC>
  257.  
  258. 3.2.7.1. Convert_Citation Function<Tab.><Tab>32
  259.  
  260. <subsubsubsectionTOC>
  261.  
  262. 3.2.7.2. View_Help Procedure<Tab.><Tab>33
  263.  
  264. <subsubsubsectionTOC>
  265.  
  266. 3.2.7.3. Dispatch Procedure<Tab.><Tab>34
  267.  
  268. <subsubsectionTOC>
  269.  
  270. 3.2.8. Screen_Display_Controller Package<Tab.><Tab>35
  271.  
  272. <subsubsubsectionTOC>
  273.  
  274. 3.2.8.1. Show_Text Procedure<Tab.><Tab>38
  275.  
  276. <subsubsubsectionTOC>
  277.  
  278. 3.2.8.2. Mark_Line Procedure<Tab.><Tab>38
  279.  
  280. <subsubsubsectionTOC>
  281.  
  282. 3.2.8.3. Show_Prompt Procedure<Tab.><Tab>39
  283.  
  284. <subsubsubsectionTOC>
  285.  
  286. 3.2.8.4. Show_Error Procedure<Tab.><Tab>39
  287.  
  288. <subsubsubsectionTOC>
  289.  
  290. 3.2.8.5. Print_Log_File_Close_Message Procedure<Tab.><Tab>40
  291.  
  292. <subsubsubsectionTOC>
  293.  
  294. 3.2.8.6. Convert Function<Tab.><Tab>40
  295.  
  296. <subsubsubsectionTOC>
  297.  
  298. 3.2.8.7. Citation_to_Display Function<Tab.><Tab>40
  299.  
  300. <subsubsectionTOC>
  301.  
  302. 3.2.9. Citation_Handler Package<Tab.><Tab>41
  303.  
  304. <subsubsubsectionTOC>
  305.  
  306. 3.2.9.1. View_Citation Procedure<Tab.><Tab>43
  307.  
  308. <subsubsubsectionTOC>
  309.  
  310. 3.2.9.2. Redisplay_Current_Screen Procedure<Tab.><Tab>43
  311.  
  312. <subsubsubsectionTOC>
  313.  
  314. 3.2.9.3. Next_Screen Procedure<Tab.><Tab>44
  315.  
  316. <subsubsubsectionTOC>
  317.  
  318. 3.2.9.4. Previous_Screen Procedure<Tab.><Tab>44
  319.  
  320. <subsubsubsectionTOC>
  321.  
  322. 3.2.9.5. Next_Citation Procedure<Tab.><Tab>45
  323.  
  324. <subsubsubsectionTOC>
  325.  
  326. 3.2.9.6. Previous_Citation Procedure<Tab.><Tab>45
  327.  
  328. <subsubsubsectionTOC>
  329.  
  330. 3.2.9.7. Push Procedure<Tab.><Tab>46
  331.  
  332. <subsubsubsectionTOC>
  333.  
  334. 3.2.9.8. Pop Procedure<Tab.><Tab>47
  335.  
  336. <subsubsubsectionTOC>
  337.  
  338. 3.2.9.9. Search_for_First_Occurrence Procedure<Tab.><Tab>48
  339.  
  340. <subsubsubsectionTOC>
  341.  
  342. 3.2.9.10. Search_for_Next_Occurrence Procedure<Tab.><Tab>49
  343.  
  344. <subsubsubsectionTOC>
  345.  
  346. 3.2.9.11. Close_All_Open_Citations Procedure<Tab.><Tab>49
  347.  
  348. <subsubsectionTOC>
  349.  
  350. 3.2.10. Primitive_Citation_Handler Package<Tab.><Tab>50
  351.  
  352. <subsubsubsectionTOC>
  353.  
  354. 3.2.10.1. DAF_Name Function<Tab.><Tab>55
  355.  
  356. <subsubsubsectionTOC>
  357.  
  358. 3.2.10.2. Open_New_Citation Procedure<Tab.><Tab>56
  359.  
  360. <subsubsubsectionTOC>
  361.  
  362. 3.2.10.3. Push Function<Tab.><Tab>57
  363.  
  364. <subsubsubsectionTOC>
  365.  
  366. 3.2.10.4. Pop Function<Tab.><Tab>57
  367.  
  368. <subsubsubsectionTOC>
  369.  
  370. 3.2.10.5. Load_Screen_Buffer Procedure<Tab.><Tab>58
  371.  
  372. <subsubsubsectionTOC>
  373.  
  374. 3.2.10.6. Next_Screen Function<Tab.><Tab>59
  375.  
  376. <subsubsubsectionTOC>
  377.  
  378. 3.2.10.7. Previous_Screen Function<Tab.><Tab>60
  379.  
  380. <subsubsubsectionTOC>
  381.  
  382. 3.2.10.8. Next_Citation Function<Tab.><Tab>60
  383.  
  384. <subsubsubsectionTOC>
  385.  
  386. 3.2.10.9. Previous_Citation Function<Tab.><Tab>61
  387.  
  388. <subsubsubsectionTOC>
  389.  
  390. 3.2.10.10. Search_First Function<Tab.><Tab>62
  391.  
  392. <subsubsubsectionTOC>
  393.  
  394. 3.2.10.11. Search_Next Function<Tab.><Tab>63
  395.  
  396. <subsubsubsectionTOC>
  397.  
  398. 3.2.10.12. Current_Citation Function<Tab.><Tab>64
  399.  
  400. <subsubsubsectionTOC>
  401.  
  402. 3.2.10.13. Close_All_Open_Citations Procedure<Tab.><Tab>64
  403.  
  404. <subsubsubsectionTOC>
  405.  
  406. 3.2.10.14. Suspend Procedure<Tab.><Tab>65
  407.  
  408. <subsubsubsectionTOC>
  409.  
  410. 3.2.10.15. Resume Procedure<Tab.><Tab>65
  411.  
  412. <subsubsubsectionTOC>
  413.  
  414. 3.2.10.16. Access_Screen Function<Tab.><Tab>66
  415.  
  416. <subsubsectionTOC>
  417.  
  418. 3.2.11. Print_Log_Handler Package<Tab.><Tab>66
  419.  
  420. <subsubsubsectionTOC>
  421.  
  422. 3.2.11.1. Print_Current_Citation  Procedure<Tab.><Tab>68
  423.  
  424. <subsubsubsectionTOC>
  425.  
  426. 3.2.11.2. Print_Current_Screen  Procedure<Tab.><Tab>68
  427.  
  428. <subsubsubsectionTOC>
  429.  
  430. 3.2.11.3. Close_Print_Log  Procedure<Tab.><Tab>69
  431.  
  432. <subsubsectionTOC>
  433.  
  434. 3.2.12. Non-Developmental CSCs<Tab.><Tab>69
  435.  
  436. <sectionTOC>
  437.  
  438. 4. CSCI data<Tab.><Tab>70
  439.  
  440. <subsectionTOC>
  441.  
  442. 4.1. SYSDEP Package<Tab.><Tab>70
  443.  
  444. <subsectionTOC>
  445.  
  446. 4.2. Citation_Definition Package Specification<Tab.><Tab>71
  447.  
  448. <subsectionTOC>
  449.  
  450. <|,iv>4.3. DAF_Handler Exported Types, Data, and Exceptions<Tab.><Tab>74
  451.  
  452. <subsectionTOC>
  453.  
  454. 4.4. Screen_Display_Controller Exported Types, Data, and Exceptions<Tab.><Tab>7
  455. 5
  456.  
  457. <subsectionTOC>
  458.  
  459. 4.5. Primitive_Citation_Handler Exported Types, Data, and Exceptions<Tab.><Tab>
  460. 75
  461.  
  462. <subsectionTOC>
  463.  
  464. 4.6. Print_Log_Handler Exported Types, Data, and Exceptions<Tab.><Tab>76
  465.  
  466. <subsectionTOC>
  467.  
  468. 4.7. Other CSCs<Tab.><Tab>76
  469.  
  470. <sectionTOC>
  471.  
  472. 5. CSCI data files<Tab.><Tab>77
  473.  
  474. <subsectionTOC>
  475.  
  476. 5.1. Data file to CSC/CSU cross reference<Tab.><Tab>77
  477.  
  478. <subsectionTOC>
  479.  
  480. 5.2. *.doc Files<Tab.><Tab>77
  481.  
  482. <subsectionTOC>
  483.  
  484. 5.3. *.daf Files<Tab.><Tab>78
  485.  
  486. <subsectionTOC>
  487.  
  488. 5.4. lrm.log File<Tab.><Tab>78
  489.  
  490. <sectionTOC>
  491.  
  492. 6. Requirements traceability<Tab.><Tab>79
  493.  
  494. <sectionTOC>
  495.  
  496. 7. Notes<Tab.><Tab>80
  497.  
  498.